<?php

/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 fdm=marker: */

/**
 * LightBot_IActionAdapter 
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://framework.zend.com/license/new-bsd
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category  LightBot
 * @package   LightBot
 * @copyright Copyright (c) 2008 Olivier Hoareau <hoareau.olivier@gmail.com>
 * @author    Olivier Hoareau <hoareau.olivier@gmail.com>
 * @license   License http://framework.zend.com/license   New BSD License
 * @version   $Id:$
 */

require_once dirname(__FILE__) . '/ILightBot.php';

// {{{ LightBot_IActionAdapter

/**
 * Action Adapter interface
 *
 * @category  LightBot
 * @package   LightBot
 * @copyright Copyright (c) 2008 Olivier Hoareau <hoareau.olivier@gmail.com>
 * @author    Olivier Hoareau <hoareau.olivier@gmail.com>
 * @license   License http://framework.zend.com/license   New BSD License
 */
interface LightBot_IActionAdapter
{
    // {{{ configure()

    /**
     * Configures the adapter with the specified configuration settings
     *
     * @param  mixed     $conf filename or array
     * @return LightBot_IActionAdapter  $this
     * @throws Exception if an error occured
     */
    public function configure($conf);

    // }}}
    // {{{ setLightBot()

    /**
     * Sets the attached light bot
     *
     * @param LightBot_ILightBot $lightBot the bot
     * @return LightBot_IActionAdapter $this
     */
    public function setLightBot(LightBot_ILightBot $lightBot);

    // }}}
    // {{{ getLightBot()

    /**
     * Returns the attached light bot
     *
     * @return LightBot_ILightBot the bot
     */
    public function getLightBot();

    // }}}
    // {{{ sendMail()

    /**
     * Sends a mail with the specified properties
     *
     * @params array $mail the mail properties
     * @return LightBot_IActionAdapter $this
     * @throws Exception if an error occured
     */
    public function sendMail($mail);

    // }}}
}   

// }}}

/*
 * Local variables:
 * tab-width: 4
 * c-basic-offset: 4
 * c-hanging-comment-ender-p: nil
 * End:
 */
